<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
<meta content="AlbumsRequestOptions,org.opensocial.client.features.AlbumsRequestOptions,addUserIds,setAlbum,setAlbumId,setCount,setGroupId,setStartIndex,setUserId,setUserIds" name="keywords">
<title>org.opensocial.client.features.AlbumsRequestOptions</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'AlbumsRequestOptions - OpenSocial Actionscript 3.0 Client Library Documentation';
				var baseRef = '../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">OpenSocial Actionscript Client Library</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?org/opensocial/client/features/AlbumsRequestOptions.html&amp;org/opensocial/client/features/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;AlbumsRequestOptions</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class AlbumsRequestOptions"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">org.opensocial.client.features</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class AlbumsRequestOptions</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">AlbumsRequestOptions <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> <a href="RequestOptions.html">RequestOptions</a></td>
</tr>
</table>
<p></p>
 Options for <code><j>osapi.albums</j></code> service. The options format is based on the
 OS-Lite style. The key names of the options object is defined in the protocol spec.
 <p>
 It's used to initialize the <code>AsyncDataRequest</code> instance.
 </p>
  <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="AsyncDataRequest.html" target="">AsyncDataRequest</a>
<br>
<a href="http://www.opensocial.org/Technical-Resources/opensocial-spec-v09/RPC-Protocol.html" target="mm_external">RPC Protocol</a>
<br>
<a href="http://www.opensocial.org/Technical-Resources/opensocial-spec-v09/RPC-Protocol.html#Albums" target="mm_external">http://www.opensocial.org/Technical-Resources/opensocial-spec-v09/RPC-Protocol.html#Albums</a>
</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<div class="showHideLinks">
<div class="hideInheritedProperty" id="hideInheritedProperty">
<a onclick="javascript:setInheritedVisible(false,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Properties</a>
</div>
<div class="showInheritedProperty" id="showInheritedProperty">
<a onclick="javascript:setInheritedVisible(true,'Property');" href="#propertySummary" class="showHideLink"><img src="../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Properties</a>
</div>
</div>
<table id="summaryTableProperty" class="summaryTable hideInheritedProperty" cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="hideInheritedProperty">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol"><a class="signatureLink" href="RequestOptions.html#value">value</a> : Object<div class="summaryTableDescription">
   Return the actual value of the options.</div>
</td><td class="summaryTableOwnerCol"><a href="RequestOptions.html">RequestOptions</a></td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#AlbumsRequestOptions()">AlbumsRequestOptions</a>(options:Object = null)</div>
<div class="summaryTableDescription">
   Constructor of the options object for albums service.</div>
</td><td class="summaryTableOwnerCol">AlbumsRequestOptions</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#addUserIds()">addUserIds</a>(... userIds):<a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a>
</div>
<div class="summaryTableDescription">
   Adds the user id values.</div>
</td><td class="summaryTableOwnerCol">AlbumsRequestOptions</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setAlbum()">setAlbum</a>(album:<a href="../base/Album.html">Album</a>):<a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a>
</div>
<div class="summaryTableDescription">
   Sets the album instance.</div>
</td><td class="summaryTableOwnerCol">AlbumsRequestOptions</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setAlbumId()">setAlbumId</a>(albumId:String):<a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a>
</div>
<div class="summaryTableDescription">
   Sets the album id.</div>
</td><td class="summaryTableOwnerCol">AlbumsRequestOptions</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setCount()">setCount</a>(count:int):<a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a>
</div>
<div class="summaryTableDescription">
   Sets the number of people to be fetch.</div>
</td><td class="summaryTableOwnerCol">AlbumsRequestOptions</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setGroupId()">setGroupId</a>(groupId:String):<a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a>
</div>
<div class="summaryTableDescription">
   Sets the group id value.</div>
</td><td class="summaryTableOwnerCol">AlbumsRequestOptions</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setStartIndex()">setStartIndex</a>(startIndex:int):<a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a>
</div>
<div class="summaryTableDescription">
   Sets the start index to be fetch.</div>
</td><td class="summaryTableOwnerCol">AlbumsRequestOptions</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setUserId()">setUserId</a>(userId:String):<a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a>
</div>
<div class="summaryTableDescription">
   Sets the user id value.</div>
</td><td class="summaryTableOwnerCol">AlbumsRequestOptions</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setUserIds()">setUserIds</a>(userIds:Array):<a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a>
</div>
<div class="summaryTableDescription">
   Sets the user id values.</div>
</td><td class="summaryTableOwnerCol">AlbumsRequestOptions</td>
</tr>
</table>
</div>
<a name="protectedMethodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Protected Methods</div>
<div class="showHideLinks">
<div class="hideInheritedProtectedMethod" id="hideInheritedProtectedMethod">
<a onclick="javascript:setInheritedVisible(false,'ProtectedMethod');" href="#protectedMethodSummary" class="showHideLink"><img src="../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Protected Methods</a>
</div>
<div class="showInheritedProtectedMethod" id="showInheritedProtectedMethod">
<a onclick="javascript:setInheritedVisible(true,'ProtectedMethod');" href="#protectedMethodSummary" class="showHideLink"><img src="../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Protected Methods</a>
</div>
</div>
<table id="summaryTableProtectedMethod" class="summaryTable hideInheritedProtectedMethod" cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="hideInheritedProtectedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="RequestOptions.html#append()">append</a>(name:String, values:Array):void</div>
<div class="summaryTableDescription">
   Appends an array of items to an array option.</div>
</td><td class="summaryTableOwnerCol"><a href="RequestOptions.html">RequestOptions</a></td>
</tr>
<tr class="hideInheritedProtectedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="RequestOptions.html#modify()">modify</a>(name:String, value:*):void</div>
<div class="summaryTableDescription">
   Modifies an option value in this options object.</div>
</td><td class="summaryTableOwnerCol"><a href="RequestOptions.html">RequestOptions</a></td>
</tr>
<tr class="hideInheritedProtectedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="RequestOptions.html#modifyDetail()">modifyDetail</a>(name:String, detailName:String, detailValue:*):void</div>
<div class="summaryTableDescription">
   Modifies one entry in the option if the option is a map.</div>
</td><td class="summaryTableOwnerCol"><a href="RequestOptions.html">RequestOptions</a></td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="AlbumsRequestOptions()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">AlbumsRequestOptions</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function AlbumsRequestOptions(options:Object = null)</code><p>
   Constructor of the options object for albums service.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">options</span>:Object</code> (default = <code>null</code>)<code></code> &mdash; Initial value for the options. If null, default values will be applied.
   </td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="addUserIds()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">addUserIds</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function addUserIds(... userIds):<a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a></code><p>
   Adds the user id values.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code>... <span class="label">userIds</span></code> &mdash; User ids to be added.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a></code> &mdash; 
                        The options itself.
   
                        
                     </td>
</tr>
</table>
</div>
<a name="setAlbum()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setAlbum</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setAlbum(album:<a href="../base/Album.html">Album</a>):<a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a></code><p>
   Sets the album instance. Only used in the <code>ALBUMS_CREATE</code> and the
   <code>ALBUMS_UPDATE</code> feature.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">album</span>:<a href="../base/Album.html">Album</a></code> &mdash; The album instance.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a></code> &mdash; 
                        The options itself.
   
                        
                     </td>
</tr>
</table>
</div>
<a name="setAlbumId()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setAlbumId</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setAlbumId(albumId:String):<a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a></code><p>
   Sets the album id. Only used in the <code>ALBUMS_UPDATE</code> and the
   <code>ALBUMS_DELETE</code> feature.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">albumId</span>:String</code> &mdash; The album id.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a></code> &mdash; 
                        The options itself.
   
                        
                     </td>
</tr>
</table>
</div>
<a name="setCount()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setCount</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setCount(count:int):<a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a></code><p>
   Sets the number of people to be fetch. Only used in the <code>ALBUMS_GET</code>
   feature.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">count</span>:int</code> &mdash; The number of the counts.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a></code> &mdash; 
                        The options itself.
   
                        
                     </td>
</tr>
</table>
</div>
<a name="setGroupId()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setGroupId</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setGroupId(groupId:String):<a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a></code><p>
   Sets the group id value.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">groupId</span>:String</code> &mdash; The group id.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a></code> &mdash; 
                        The options itself.
   
                        
                     </td>
</tr>
</table>
</div>
<a name="setStartIndex()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setStartIndex</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setStartIndex(startIndex:int):<a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a></code><p>
   Sets the start index to be fetch. Only used in the <code>ALBUMS_GET</code> feature.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">startIndex</span>:int</code> &mdash; The number of the start index.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a></code> &mdash; 
                        The options itself.
   
                        
                     </td>
</tr>
</table>
</div>
<a name="setUserId()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setUserId</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setUserId(userId:String):<a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a></code><p>
   Sets the user id value.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">userId</span>:String</code> &mdash; The user id. Can be "</td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a></code> &mdash; 
                        The options itself.
   
                        
                     </td>
</tr>
</table>
</div>
<a name="setUserIds()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setUserIds</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setUserIds(userIds:Array):<a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a></code><p>
   Sets the user id values.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">userIds</span>:Array</code> &mdash; An array of user ids.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../features/AlbumsRequestOptions.html">AlbumsRequestOptions</a></code> &mdash; 
                        The options itself.
   
                        
                     </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">2010 OpenSocial</center>
</div>
</body>
</html>
<!--2010 OpenSocial-->
